Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api-reference: Add typedoc support, refactor #1504

Merged
merged 2 commits into from
Sep 21, 2023
Merged

Conversation

matevz
Copy link
Member

@matevz matevz commented Sep 20, 2023

This PR:

  • adds or bumps typedoc of client-sdk/ts-web packages
  • adds generation of typedoc to CI
  • reorganizes api-reference branch to first include the language and inside the API reference of the corresponding packages (currently rust and js)

TODO

https://github.com/oasisprotocol/docs-api now also contains symbolic links merging together docs from oasis-sdk and sapphire-paratimes repos of different languages. Rust API reference links used at docs.oasis.io should now point to https://api.docs.oasis.io/rust/* instead of https://api.docs.oasis.io/oasis-sdk. Remove the oasis-sdk symbolic link in api-reference branch once the links on docs.oasis.io are updated.

@codecov
Copy link

codecov bot commented Sep 20, 2023

Codecov Report

Merging #1504 (861ffe9) into main (54f5df8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1504   +/-   ##
=======================================
  Coverage   60.39%   60.39%           
=======================================
  Files         138      138           
  Lines        9734     9734           
=======================================
  Hits         5879     5879           
  Misses       3813     3813           
  Partials       42       42           

Copy link
Member

@kostko kostko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this ready to review?

.github/workflows/ci-docs.yaml Outdated Show resolved Hide resolved
@matevz matevz force-pushed the matevz/feature/typedoc branch from 557b115 to fb817a6 Compare September 20, 2023 14:44
@matevz matevz marked this pull request as draft September 20, 2023 14:44
@matevz matevz force-pushed the matevz/feature/typedoc branch from fb817a6 to 217c2ac Compare September 20, 2023 15:23
@matevz
Copy link
Member Author

matevz commented Sep 20, 2023

Ok, this is now ready for review.

@matevz matevz marked this pull request as ready for review September 20, 2023 15:30
Copy link
Contributor

@pro-wh pro-wh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oo thanks

so generated docs appear in doc/, while other docs live in docs/ :face_with_spiral_eyes:

@matevz matevz force-pushed the matevz/feature/typedoc branch from 217c2ac to eec2259 Compare September 21, 2023 09:19
@matevz
Copy link
Member Author

matevz commented Sep 21, 2023

so generated docs appear in doc/, while other docs live in docs/ 😵‍💫

I slept over this and realized we can simply store the generated docs inside the docs/api folder. Fixed.

@matevz matevz force-pushed the matevz/feature/typedoc branch from 825d6d1 to 861ffe9 Compare September 21, 2023 10:37
@matevz matevz enabled auto-merge September 21, 2023 10:45
@matevz matevz merged commit e57d909 into main Sep 21, 2023
27 checks passed
@matevz matevz deleted the matevz/feature/typedoc branch September 21, 2023 11:01
github-actions bot added a commit that referenced this pull request Sep 21, 2023
…atevz/feature/typedoc

api-reference: Add typedoc support, refactor e57d909
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants